Abrir um lote de pagamentos
Cria um lote vazio. Depois, inclua pagamentos com POST /payments informando batchRef e dispare tudo de uma vez com PATCH /batches/{batchId}. Os parâmetros expiresAt e maxSize limitam por quanto tempo o lote fica aberto e quantos pagamentos aceita.
O status e os contadores do lote são calculados a partir dos pagamentos dele. Se o lote exigir aprovação, uma única aprovação libera todos os pagamentos.
Envie X-Idempotency-Key: sem ela, repetir a chamada depois de uma falha de rede abriria dois lotes e parte dos pagamentos ficaria em um lote diferente do que você aprovou.
Request Specifications
Request
Responses
- 201
- 400
- 422
Lote aberto
400 — a requisição não pôde ser interpretada. Duas causas: missing-idempotency-key, quando um POST ou PATCH não traz X-Idempotency-Key; e invalid-body, quando o corpo não segue o schema da operação (campo obrigatório ausente ou tipo errado). O campo invalidParams indica o que corrigir.
Combinação de campos inválida. invalidParams indica o que corrigir.